GetLabel

GetLabel
Header:	Icons.h		Carbon status:	Supported

Gets the color and string used for a given label in the Label menu of the Finder and in the Labels control panel.

OSErr GetLabel (
    SInt16 labelNumber, 
    RGBColor *labelColor, 
    Str255 labelString
);

labelNumber: An integer from 1 to 7 indicating which label’s information is requested.
labelColor: On return, a pointer to the color of the specified label.
labelString: On return, the string associated with the specified label.

function result: A result code.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.